You are here:

Extract Query Results

{ extractQueryResult }

Runs a content item and extracts the raw query result data into the specified format (CSV, JSON, XML).

Method

/API3/analytics/extractQueryResult

API Section: /API3/analytics

API Version: 3.0

From Release: 2023.10

Usage: REST API and Client SDK libraries. REST APIs via POST actions only.

Usage by:

Enterprise Admin
Domain Admin
Pro
Analyst
Viewer
Basic

Input Parameters

Name

data

Object Type

QueryExportData

Description

The query export object used to specify how to extract nlp query results.

Output Response

Successful Result Code

200

Response Type

string

Description of Response Type

successful operation

Notes

Queries are extracted in flattened tabular format – and do not represent the cartesian of the data. Multiple queries can be extracted into XML or JSON formats only. The CSV option is only available for single queries running from Discovery content.

Examples

Running Queries and Slicers programmatically (JavaScript):

This example demonstrates how to run queries and slicers (parameters) programmatically to extract results.

The example uses API authentication driven from JavaScript. See Authentication APIs for alternatives.

// URL of the Pyramid installation and the path to the API 3.0 REST methods
var pyramidURL = "http://mysite.com/api3/";


// step 1: authenticate admin account and get token
// NOTE: callApi method is a generic REST method shown below.
let token = callApi("authentication/authenticateUser",{
	"userName":"adminUser",
	"password":"abc123!"
},token,false);


//step 2: find a parameter definition called "param x". Parameters are saved items to drive slicers
let calculation = callApi("content/findContentItem",{
	"searchString": "param x",
	"filterTypes": [2],
	"searchMatchType": 2,
	"searchRootFolderType":0
},token // admin token generated above
);

let paramId = calculation[0].id;

//step 3: get the parameter's elements
let parameterElements = callApi("analytics/getParameterElements",paramId,token);

let members = parameterElements.members // list for members
console.log(members);

//step 4: find a data discovery called "report x"
let dataDiscovery = callApi("content/findContentItem",{
	"searchString": "report x",
	"filterTypes": [3],
	"searchMatchType": 2,
	"searchRootFolderType":0
},token // admin token generated above
);


let reportId = dataDiscovery[0].id;

//step 5: extract the report results as JSON that have been filtered by the first member of the parameter found in step 3
let queryResult = callApi("analytics/extractQueryResult",{
	  "itemId":reportId,
      "exportType":0, //JSON
      "exportOptions": {},
      "externalParameters": {
        "reportFilters" : [
         {
         "value": members[0].uniqueName
         }
        ]
      }
},token);

console.log(JSON.parse(queryResult));


// ##### optional generic logging method for debugging ##############
function log(msg){
	document.write(msg);
	console.log(msg);
}

// ##### generic REST API calling method ##############
function callApi(path,data,token="",parseResult=true){
	var xhttp = new XMLHttpRequest();
	xhttp.open("POST", pyramidURL+path, false);
	xhttp.setRequestHeader("paToken",token)
	xhttp.send(JSON.stringify(data));
	if(parseResult){
		return JSON.parse(xhttp.responseText);
	}else{
		return xhttp.responseText;
	}
}

User Client/API Authentication (C#):

This example demonstrates how to authenticate users with Windows Authentication and run a query programmatically.

using System;
using System.Linq;
using System.Web;
using Newtonsoft.Json;
using Newtonsoft.Json.Linq;
using System.Net.Http;
using System.Text;
using System.Threading.Tasks;

namespace CsWebSite
{
	public partial class WinAuth : System.Web.UI.Page
	{
		public const String API_PATH = "http://mySite.com/api3/";
		protected void Page_Load(object sender, EventArgs e)
		{
			//logging the current user with windows auth
			String userToken = getToken("authenticateUserWindows", null);

			Response.Cookies.Add(new HttpCookie("PyramidAuth", userToken));

			//running a query. The user needs to be an admin user to access this API.
			JToken result = callApi("analytics/extractQueryResult", new
			{
				itemId= "9185ea22-bf14-4606-a955-4bbd73a88c38", //content items ID
				exportType =0,//export result as json, we can do xml(1) and CSV(2) as well
				exportOptions=new
				{
					showUniqueName=true
				}
			},userToken);
			//the result is passed as a json string, needed to be deserialized again to read the values
			JToken document = JsonConvert.DeserializeObject>JObject<(result.ToString());
			String firstResult = document["Document"]["queries"][0]["result"]["data"][0][0].ToString();
		}

		//this method is diffrent then the normal to pass windows credentals UseDefaultCredentials=true
		private String getToken(String service, Object data)
		{
			HttpClient client = new HttpClient(new HttpClientHandler()
			{
				UseDefaultCredentials = true
			});

			StringContent content = null;
			content = new StringContent(JsonConvert.SerializeObject(data), Encoding.UTF8, "application/json");
			Task<HttpResponseMessage> response = client.PostAsync(API_PATH + "authentication/" + service, content);

			return response.Result.Content.ReadAsStringAsync().Result;
		}
		
		//generic method for calling REST methods
		private JToken callApi(String service, Object data, String token)
		{
			HttpClient client = new HttpClient();
			client.DefaultRequestHeaders.Add("paToken", token);

			StringContent content = null;
			content = new StringContent(JsonConvert.SerializeObject(data), Encoding.UTF8, "application/json");
			Task>HttpResponseMessage< response = client.PostAsync(API_PATH + service, content);

			String resultStr = response.Result.Content.ReadAsStringAsync().Result;
			if (resultStr.Count() == 0)
			{
				return null;
			}
			return JsonConvert.DeserializeObject>JObject<(resultStr)["data"];
		}
	}
}

Code Snippets

Use the Authentication API methods to generate an access 'key' or 'token' for use in code as shown below.

TypeScript

Curl

Java

Python

PHP

curl -X POST \
-H "paToken: [[apiKey]]" \
 -H "Accept: application/json,application/json;charset=utf-8,text/csv,text/csv;charset=utf-8,application/xml,application/xml;charset=utf-8,text/plain,text/plain;charset=utf-8" \
 -H "Content-Type: application/json" \
 "http://Your.Server.URL/API3/analytics/extractQueryResult" \
 -d '{
  "itemId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "queryStateId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "exportOptions" : {
    "columnHeaderAsCaption" : true,
    "removeValueBasedFilters" : true,
    "showUniqueName" : true
  },
  "externalParameters" : {
    "reportFilters" : [ {
      "targetParameterId" : "targetParameterId",
      "value" : "value"
    }, {
      "targetParameterId" : "targetParameterId",
      "value" : "value"
    } ],
    "slideNumber" : 0,
    "targets" : [ {
      "name" : "name",
      "filters" : [ {
        "targetParameterId" : "targetParameterId",
        "value" : "value"
      }, {
        "targetParameterId" : "targetParameterId",
        "value" : "value"
      } ]
    }, {
      "name" : "name",
      "filters" : [ {
        "targetParameterId" : "targetParameterId",
        "value" : "value"
      }, {
        "targetParameterId" : "targetParameterId",
        "value" : "value"
      } ]
    } ]
  }
}'

import com.pyramidanalytics.*;
import com.pyramidanalytics.auth.*;
import com.pyramidanalytics.model.*;
import com.pyramidanalytics.api.AnalyticsServiceApi;

import java.util.*;
import java.time.*;

public class AnalyticsServiceApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://Your.Server.URL/");
        
        // Configure API key authorization: paToken
        ApiKeyAuth paToken = (ApiKeyAuth) defaultClient.getAuthentication("paToken");
        paToken.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //paToken.setApiKeyPrefix("Token");

        // Create an instance of the API class
        AnalyticsServiceApi apiInstance = new AnalyticsServiceApi();
        // Initialize the data parameter object for the call
        QueryExportData data = ; // Create the input object for the operation, type: QueryExportData 

        try {
            String result = apiInstance.extractQueryResult(data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnalyticsServiceApi#extractQueryResult");
            e.printStackTrace();
        }
    }
}

import * as PyramidAnalyticsWebApi from "com.pyramidanalytics";

// Create an instance of the API class
const api = new PyramidAnalyticsWebApi.AnalyticsServiceApi("http://Your.Server.URL")

// Configure API key authorization: paToken
api.setApiToken("YOUR API KEY");

const data = ; // {QueryExportData} 

api.extractQueryResult(data).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

using System;
using System.Diagnostics;
using PyramidAnalytics.Sdk.Api;
using PyramidAnalytics.Sdk.Client;
using PyramidAnalytics.Sdk.Model;

public class extractQueryResultExample
{
    public static void Main()
    {
        Configuration conf = new Configuration();
        conf.BasePath = "http://Your.Server.URL/";
        
        
        // Configure API key authorization: paToken
        conf.ApiKey.Add("paToken", "YOUR_API_KEY");
        // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
        // conf.ApiKeyPrefix.Add("paToken", "Bearer");

        GlobalConfiguration.Instance = conf;
        
        // Create an instance of the API class
        var apiInstance = new AnalyticsServiceApi();
        // Initialize the data parameter object for the call
        var data = new QueryExportData(); // QueryExportData | 

        try {
            // Runs a content item and extracts the raw query result data into the specified format (CSV, JSON, XML).
            string result = apiInstance.extractQueryResult(data);
            Debug.WriteLine(result);
        } catch (Exception e) {
            Debug.Print("Exception when calling AnalyticsServiceApi.extractQueryResult: " + e.Message );
        }
    }
}

import com.pyramidanalytics
from com.pyramidanalytics import ApiException
from com.pyramidanalytics import AnalyticsServiceApi
from pprint import pprint

        
# Configure API key authorization: paToken
api_config = com.pyramidanalytics.Configuration(host = 'http://Your.Server.URL/', api_key={ paToken:'YOUR_ACCESS_TOKEN' })

with com.pyramidanalytics.ApiClient(api_config) as api_client:
    # Create an instance of the API class
    api_instance = AnalyticsServiceApi(api_client)
    # Initialize the data parameter object for the call
    data =  # QueryExportData | 

    try:
        # Runs a content item and extracts the raw query result data into the specified format (CSV, JSON, XML).
        api_response = api_instance.extract_query_result(data)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AnalyticsServiceApi->extractQueryResult: %s\n" % e)

<?php
require_once(__DIR__ . '/vendor/autoload.php');

OpenAPITools\Client\Configuration::getDefaultConfiguration()->setHost('http://Your.Server.URL');

// Configure API key authorization: paToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('paToken', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('paToken', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AnalyticsServiceApi();
$data = ; // QueryExportData | 

try {
    $result = $api_instance->extractQueryResult($data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsServiceApi->extractQueryResult: ', $e->getMessage(), PHP_EOL;
}
?>

Feedback

Couldn't find what I was looking for

Help was confusing, unclear or incomplete

Instructions didn't work